<html>
<head><meta charset="utf-8"><title>Build instructions in README · general · Zulip Chat Archive</title></head>
<h2>Stream: <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/index.html">general</a></h2>
<h3>Topic: <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Build.20instructions.20in.20README.html">Build instructions in README</a></h3>

<hr>

<base href="https://rust-lang.zulipchat.com">

<head><link href="https://rust-lang.github.io/zulip_archive/style.css" rel="stylesheet"></head>

<a name="154409391"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Build%20instructions%20in%20README/near/154409391" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> RalfJ <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Build.20instructions.20in.20README.html#154409391">(Jan 04 2019 at 13:38)</a>:</h4>
<p>I just had a mentee think they have to do <code>x.py install</code> to do their development because that's what it says in the quick-start guide of <a href="https://github.com/rust-lang/rust/blob/master/README.md" target="_blank" title="https://github.com/rust-lang/rust/blob/master/README.md">https://github.com/rust-lang/rust/blob/master/README.md</a></p>



<a name="154409424"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Build%20instructions%20in%20README/near/154409424" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> RalfJ <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Build.20instructions.20in.20README.html#154409424">(Jan 04 2019 at 13:38)</a>:</h4>
<p>A much better place for them to find would have been <a href="https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md#building" target="_blank" title="https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md#building">https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md#building</a></p>



<a name="154409515"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Build%20instructions%20in%20README/near/154409515" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> RalfJ <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Build.20instructions.20in.20README.html#154409515">(Jan 04 2019 at 13:40)</a>:</h4>
<p>I wonder if it is worth putting that more prominently in the README, or putting the manual install instructions (which we dont really want anyone to use) further down or even into a separate file.</p>



<a name="154409518"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Build%20instructions%20in%20README/near/154409518" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> RalfJ <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Build.20instructions.20in.20README.html#154409518">(Jan 04 2019 at 13:40)</a>:</h4>
<p>Cc <span class="user-mention" data-user-id="116011">@Steve Klabnik</span></p>



<a name="154436650"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Build%20instructions%20in%20README/near/154436650" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> centril <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Build.20instructions.20in.20README.html#154436650">(Jan 04 2019 at 20:56)</a>:</h4>
<p><span class="user-mention" data-user-id="120791">@RalfJ</span>  we might want to prominently link to the rustc guide in the readme if not done already?</p>



<a name="154436666"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Build%20instructions%20in%20README/near/154436666" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> centril <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Build.20instructions.20in.20README.html#154436666">(Jan 04 2019 at 20:57)</a>:</h4>
<p>like "this readme may be outdated... refer to the rustc guide first"</p>



<a name="154436674"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Build%20instructions%20in%20README/near/154436674" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> RalfJ <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Build.20instructions.20in.20README.html#154436674">(Jan 04 2019 at 20:57)</a>:</h4>
<p>it's linked but may below these install instructions</p>



<a name="154436681"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Build%20instructions%20in%20README/near/154436681" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> RalfJ <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Build.20instructions.20in.20README.html#154436681">(Jan 04 2019 at 20:57)</a>:</h4>
<p>if its outdated maybe we should just remove most of its content?^^</p>



<a name="154436704"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Build%20instructions%20in%20README/near/154436704" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> centril <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Build.20instructions.20in.20README.html#154436704">(Jan 04 2019 at 20:57)</a>:</h4>
<p>yeah maybe; I really like: <a href="https://rust-lang.github.io/rustc-guide/tests/intro.html" target="_blank" title="https://rust-lang.github.io/rustc-guide/tests/intro.html">https://rust-lang.github.io/rustc-guide/tests/intro.html</a></p>



<a name="154436754"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Build%20instructions%20in%20README/near/154436754" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> centril <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Build.20instructions.20in.20README.html#154436754">(Jan 04 2019 at 20:58)</a>:</h4>
<p>and: <a href="https://rust-lang.github.io/rustc-guide/how-to-build-and-run.html" target="_blank" title="https://rust-lang.github.io/rustc-guide/how-to-build-and-run.html">https://rust-lang.github.io/rustc-guide/how-to-build-and-run.html</a></p>



<a name="154436777"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Build%20instructions%20in%20README/near/154436777" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> centril <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Build.20instructions.20in.20README.html#154436777">(Jan 04 2019 at 20:59)</a>:</h4>
<p><span class="user-mention" data-user-id="120791">@RalfJ</span> it makes sense not to duplicate content because inevitably the readme will be outdated when changes to the guide are made</p>



<a name="154436787"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Build%20instructions%20in%20README/near/154436787" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> centril <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Build.20instructions.20in.20README.html#154436787">(Jan 04 2019 at 20:59)</a>:</h4>
<p>cause people forget to update the readme...</p>



<a name="154468641"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Build%20instructions%20in%20README/near/154468641" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> RalfJ <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Build.20instructions.20in.20README.html#154468641">(Jan 05 2019 at 10:41)</a>:</h4>
<p>well mostly I am not sure what the purpose of he README is -- who's expected to go there for which information. it's kind of the "start page" on the repo on github, after all</p>



<a name="157271897"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Build%20instructions%20in%20README/near/157271897" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> pnkfelix <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Build.20instructions.20in.20README.html#157271897">(Jan 31 2019 at 13:39)</a>:</h4>
<p>In the short term it seems like it would be reasonable to at least change the "Build and install" step into two distinct "build" and "install" steps, and mark the "install" step optional.</p>



<a name="157271996"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Build%20instructions%20in%20README/near/157271996" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> pnkfelix <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Build.20instructions.20in.20README.html#157271996">(Jan 31 2019 at 13:40)</a>:</h4>
<p><a href="https://github.com/rust-lang/rust/issues/57746" target="_blank" title="https://github.com/rust-lang/rust/issues/57746">#57746</a> did at least add an additional link to the rustc-guide</p>



<a name="157272744"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/122651-general/topic/Build%20instructions%20in%20README/near/157272744" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> RalfJ <a href="https://rust-lang.github.io/zulip_archive/stream/122651-general/topic/Build.20instructions.20in.20README.html#157272744">(Jan 31 2019 at 13:53)</a>:</h4>
<p>so we got <a href="https://rust-lang.github.io/rustc-guide/how-to-build-and-run.html" target="_blank" title="https://rust-lang.github.io/rustc-guide/how-to-build-and-run.html">https://rust-lang.github.io/rustc-guide/how-to-build-and-run.html</a> and <a href="https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md" target="_blank" title="https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md">https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md</a> with quite some overlap, it seems?</p>



<hr><p>Last updated: Aug 07 2021 at 22:04 UTC</p>
</html>